/*
 * Copyright 2012-2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.cloud.client.loadbalancer.reactive;

import org.springframework.cloud.client.ServiceInstance;
import org.springframework.core.annotation.Order;
import org.springframework.web.reactive.function.client.ClientRequest;

/**
 * Allows applications to transform the load-balanced {@link ClientRequest} given the
 * chosen {@link ServiceInstance}.
 *
 * @author Toshiaki Maki
 */
@Order(LoadBalancerClientRequestTransformer.DEFAULT_ORDER)
public interface LoadBalancerClientRequestTransformer {

	/**
	 * Order for the load balancer request tranformer.
	 */
	int DEFAULT_ORDER = 0;

	ClientRequest transformRequest(ClientRequest request, ServiceInstance instance);

}
